home *** CD-ROM | disk | FTP | other *** search
/ Creative Computers / Creative Computers CD-ROM, Volume 1 (Legendary Design Technologies, Inc.)(1994).iso / commercial / inovatronics / candodemo / helpfiles / object control  < prev    next >
Text File  |  1994-11-17  |  7KB  |  322 lines
  1. C- AttachObject        |attachobject|
  2. C- DetachObject            |detachobject|
  3. C- DisableObject        |disableobject|
  4. C- EnableObject            |enableobject|
  5. C- FastFeedBack            |fastfeedback|
  6. C- GetPropPosition        |getpropposition|
  7. C- GetPropRange            |getproprange|
  8. C- GetPropVisibleRange    |getpropvisiblerange|
  9. F- IntegerFrom            |integerfrom|
  10. V- KeyPressed            |keypressed|
  11. C- MoveObject            |moveobject|
  12. F- ObjectAttached        |objectattached|
  13. V- ObjectName            |objectname|
  14. F- ObjectState            |objectstate|
  15. V- QualifiersPressed    |qualifierspressed|
  16. C- ReattachObject        |reattachobject|
  17. C- RefreshObject        |refreshobject|
  18. C- SetInteger            |setinteger|
  19. C- SetObjectState        |setobjectstate|
  20. C- SetPropPosition        |setpropposition|
  21. C- SetPropRange            |setproprange|
  22. C- SetPropVisibleRange    |setpropvisiblerange|
  23. C- SetText                |settext|
  24. F- TextFrom                |textfrom|
  25. [E]
  26.  
  27. |attachobject|
  28. WT AttachObject {ObjectName} [,{Arg1} [,up to ten arguments]]
  29. PL This will attach an object that has been
  30. PL detached.  This will cause an error if the
  31. PL object is already attached.
  32. PL
  33. PT SEE ALSO: 
  34. BS DetachObject
  35. PT , 
  36. BS ReattachObject
  37. PL
  38. PT           and 
  39. BS ObjectAttached
  40. PL .
  41. ED
  42.  
  43. |detachobject|
  44. WT DetachObject {ObjectName}
  45. PL Detach an object from the card.  All objects
  46. PL can be detached, but the imagery of graphic
  47. PL objects will not be erased.  See the manual
  48. PL for a full description of this command.
  49. PL
  50. PT SEE ALSO: 
  51. BS ReAttachObject
  52. PT  and 
  53. BS ObjectAttached
  54. PT .
  55. ED
  56.  
  57. |disableobject|
  58. WT DisableObject {ObjectName}
  59. PL This will ghost a graphic object until
  60. PL the object has been enabled.  This only
  61. PL works on Buttons, Fields and Menus.
  62. PL 
  63. PT SEE ALSO: 
  64. BS EnableObject
  65. PT .
  66. ED
  67.  
  68. |enableobject|
  69. WT EnableObject {ObjectName}
  70. PL This will enable a graphic object that
  71. PL has been disabled.  This will do nothing
  72. PL if the object was not disabled.
  73. PL 
  74. PT SEE ALSO: 
  75. BS DisableObject
  76. PT .
  77. ED
  78.  
  79. |fastfeedback|
  80. WT FastFeedBack {Logical}
  81. PL Enables or disables FastFeedBack on mouse
  82. PL movements for an Object's Drag script.
  83. PL See the manual for a full description
  84. PL of this command.
  85. ED
  86.  
  87. |getpropposition|
  88. WT GetPropPosition {ObjectName}, <HorizPosVarName> [,<VertPosVarName>]
  89. PL This will retrieve a proportional object's
  90. PL positional values.
  91. PL
  92. PT SEE ALSO: 
  93. BS SetPropPosition
  94. PT , 
  95. BS GetPropRange
  96. PL  
  97. PT           and 
  98. BS GetPropVisibleRange
  99. PT .
  100. ED
  101.  
  102. |getproprange|
  103. WT GetPropRange {ObjectName}, <LowHorizVarName>, <HighHorizVarName> [,<LowVertVarName>, <HighVertVarName>]
  104. PL This will retrieve a proportional object's
  105. PL upper and lower range limits.
  106. PL
  107. PT SEE ALSO: 
  108. BS SetPropRange
  109. PT , 
  110. BS GetPropPosition
  111. PL 
  112. PT           and 
  113. BS GetPropVisibleRange
  114. PT .
  115. ED
  116.  
  117. |getpropvisiblerange|
  118. WT GetPropVisibleRange {ObjectName}, <DisplayHorizVarName> [,<DisplayVertVarName>]
  119. PL This will retrieve a proportional object's
  120. PL visible size.
  121. PL
  122. PT SEE ALSO: 
  123. BS SetPropVisibleRange
  124. PT , 
  125. BS GetPropRange
  126. PL
  127. PT           and 
  128. BS GetPropPosition
  129. PT .
  130. ED
  131.  
  132. |integerfrom|
  133. WT {Integer}=IntegerFrom({ObjectName})
  134. PL Returns the integer currently held in
  135. PL in the Integer Field {ObjectName}.
  136. PL
  137. PT SEE ALSO: 
  138. BS TextFrom
  139. PT  and 
  140. BS SetInteger
  141. PT .
  142. ED
  143.  
  144. |keypressed|
  145. WT {String}=KeyPressed
  146. PL This returns the key that was pressed
  147. PL when used with a KeyInput object that
  148. PL is looking for ANY key.
  149. PL
  150. PT SEE ALSO: 
  151. BS QualifiersPressed
  152. PT .
  153. ED
  154.  
  155. |moveobject|
  156. WT MoveObject {ObjectName},{X},{Y}
  157. PL Moves an object in the visible window
  158. PL to the coordinates {X},{Y}.
  159. ED
  160.  
  161. |objectattached|
  162. WT {Logical}=ObjectAttached({ObjectName})
  163. PT Returns 
  164. BS True
  165. PL  if the named object is
  166. PL currently attached.
  167. PL
  168. PT SEE ALSO: 
  169. BS DetachObject
  170. PT  and 
  171. BS ReattachObject
  172. PT .
  173. ED
  174.  
  175. |objectname|
  176. WT {String}=ObjectName
  177. PL This returns the name of the currently
  178. PL running object.
  179. ED
  180.  
  181. |objectstate|
  182. WT {Logical}=ObjectState({ObjectName})
  183. PL This indicates if the object is currently
  184. PL selected.  With menus this also indicates
  185. PL if the item's checkmark is checked.
  186. PL
  187. PT SEE ALSO: 
  188. BS SetObjectState
  189. PT .
  190. ED
  191.  
  192. |qualifierspressed|
  193. WT {String}=QualifiersPressed
  194. PL String of words, one for each qualifier
  195. PL pressed in the last keyboard input, or
  196. PL NONE if none.  Qualifiers include:  CONTROL,
  197. PL CAPSLOCK, RIGHTALT, LEFTALT, RIGHTSHIFT,
  198. PL LEFTSHIFT, LEFTAMIGA, RIGHTAMIGA, LEFTMOUSE,
  199. PL MIDDLEMOUSE, and RIGHTMOUSE.
  200. ED
  201.  
  202. |reattachobject|
  203. WT ReattachObject {ObjectName} [,{Arg1} [,up to ten arguments]]
  204. PL This will attach an object that has been
  205. PL detached.  This will do nothing if the
  206. PL object is already attached.
  207. PL
  208. PT SEE ALSO: 
  209. BS DetachObject
  210. PT  and 
  211. BS ObjectAttached
  212. PT .
  213. ED
  214.  
  215. |refreshobject|
  216. WT RefreshObject {ObjectName} ;<- only works on document objects
  217. PL Update the display of a document of list
  218. PL object.  While this normally occurs at the
  219. PL end of each script, this command forces the
  220. PL update to occur during the script.  THIS
  221. PL SHOULD ONLY BE USED WITH DOCUMENT OBJECTS!
  222. ED
  223.  
  224. |setinteger|
  225. WT SetInteger {ObjectName}, {Integer}
  226. PL Sets the value displayed in the Integer
  227. PL Field indicated by {ObjectName} to the
  228. PL given {Integer}.
  229. PL
  230. PT SEE ALSO: 
  231. BS SetText
  232. PT  and 
  233. BS IntegerFrom
  234. PT .
  235. ED
  236.  
  237. |setobjectstate|
  238. WT SetObjectState {ObjectName}, {Logical}
  239. PT Used to deselect or select an Object.  
  240. BS True
  241. PL
  242. PT will select the Object, 
  243. BS False
  244. PL  will deselect
  245. PL the Object.  If the object is a "checkable"
  246. PL menu item or checkmark toggle button, this
  247. PL will set or clear the check mark.
  248. PT SEE ALSO: 
  249. BS ObjectState
  250. PT .
  251. ED
  252.  
  253. |setpropposition|
  254. WT SetPropPosition {ObjectName}, {HorizPos} [,{VertPos}]
  255. PL This will set a proportional object's
  256. PL positional values.
  257. PL
  258. PT SEE ALSO: 
  259. BS GetPropPosition
  260. PT , 
  261. BS SetPropRange
  262. PL  
  263. PT           and 
  264. BS SetPropVisibleRange
  265. PT .
  266. ED
  267.  
  268. |setproprange|
  269. WT SetPropRange {ObjectName}, {LowHoriz}, {HighHoriz} [,{LowVert}, {HighVert}]
  270. PL This will set a proportional object's
  271. PL upper and lower range limits.
  272. PL
  273. PT SEE ALSO: 
  274. BS GetPropRange
  275. PT , 
  276. BS SetPropPosition
  277. PL 
  278. PT           and 
  279. BS SetPropVisibleRange
  280. PT .
  281. ED
  282.  
  283. |setpropvisiblerange|
  284. WT SetPropVisibleRange {ObjectName}, {DisplayHoriz} [,{DisplayVert}]
  285. PL This will set a proportional object's
  286. PL visible size.
  287. PL
  288. PT SEE ALSO: 
  289. BS GetPropVisibleRange
  290. PT , 
  291. BS SetPropRange
  292. PL
  293. PT           and 
  294. BS SetPropPosition
  295. PT .
  296. ED
  297.  
  298. |settext|
  299. WT SetText {ObjectName},{String}
  300. PL Sets the string displayed in the text
  301. PL Field indicated by {ObjectName} to the
  302. PL given {String}.
  303. PL
  304. PT SEE ALSO: 
  305. BS SetInteger
  306. PT  and 
  307. BS TextFrom
  308. PT .
  309. ED
  310.  
  311. |textfrom|
  312. WT {String}=TextFrom({ObjectName})
  313. PL Returns the string currently held in
  314. PL in the Text Field {ObjectName}.
  315. PL
  316. PT SEE ALSO: 
  317. BS IntegerFrom
  318. PT  and 
  319. BS SetText
  320. PT .
  321. ED
  322.